issue #628 save_user_coords by hxdimpf · Pull Request #629 · opencaching/okapi

hxdimpf · 2023-11-23T08:40:32Z

This is about adding a new service endpoint. The platforms (opencaching.xx) provide the capabilities to maintain a personal cache notes field for each cache. In addition with this there is also a capability to store user provided coordinates for instance the coordinates that are the result of solving a puzzle.

The OKAPI provides a service to retrieve the personal caches notes and also the user_coords. It also provides a service to update the personal cache notes but not the user coords.

I have implemented a new service to fill this gap. First I thought about extending the already existing service

:: services/caches/save_personal_notes

however, to make sure that this doesn't create any adverse side effects for existing client applications I decided to implement a new service:
:: services/caches/save_user_coords.

bekuno · 2023-11-27T11:16:58Z

If you want a feedback from c:geo side, please open an issue there.

Use a simple '' instead of Db::escape_string("") for the empty description value in the INSERT statement.

stefopl · 2026-05-07T12:56:25Z

+        else # oc.pl branch
+        {
+            $rs = Db::query("
+                select max(id) as id
+                from cache_mod_cords
+                where
+                    cache_id    = '".Db::escape_string($cache_id)."'
+                    and user_id = '".Db::escape_string($user_id)."'
+            ");
+            $id = null;
+            if($row = Db::fetch_assoc($rs)) {
+                $id = $row['id'];
+            }
+            if ($id == null) {
+                Db::query("
+                    insert into cache_mod_cords (
+                        cache_id, user_id, latitude, longitude
+                    ) values (
+                        '".Db::escape_string($cache_id)."',
+                        '".Db::escape_string($user_id)."',
+                        '".Db::escape_string($latitude)."',
+                        '".Db::escape_string($longitude)."'
+                    )
+                ");
+            } else {
+                Db::query("
+                    update cache_mod_cords
+                    set latitude  = '".Db::escape_string($latitude)."',
+                        longitude = '".Db::escape_string($longitude)."'
+                    where
+                        id = '".Db::escape_string($id)."'
+                ");
+            }
+        }
+    }


OCPL cache_mod_cords table does not contain an id column.

create table cache_mod_cords ( cache_id int not null, user_id int not null, date timestamp default current_timestamp() not null, longitude double not null, latitude double not null, primary key (cache_id, user_id) )

it should look something like this:

else # oc.pl branch { Db::query(" INSERT INTO cache_mod_cords ( cache_id, user_id, latitude, longitude, date ) VALUES ( '".Db::escape_string($cache_id)."', '".Db::escape_string($user_id)."', '".Db::escape_string($latitude)."', '".Db::escape_string($longitude)."', NOW() ) ON DUPLICATE KEY UPDATE latitude = VALUES(latitude), longitude = VALUES(longitude), date = NOW() "); }

Additionally, in OCPL only some cache types support user coordinates:
https://github.com/opencaching/opencaching-pl/blob/30ae3a4681c6840fe5aad454ccdb50fdb1340603/src/Controllers/ViewCacheController.php#L646-L648

I have commited your suggested else path.

With respect go the cache types that support user coordinates: in OCDE all do. I don't know how to access ocpl source code so pls send me the list of cache types that do support it then I will add the filtering.

cache_mod_cords has a composite PK (cache_id, user_id) with no id column, so the previous select max(id) would fail at runtime.

stefopl

The documentation should also be updated to include these changes.

stefopl · 2026-05-26T17:44:45Z

+            'services/caches/geocache',
+            new OkapiInternalRequest($request->consumer, $request->token, array(
+                'cache_code' => $cache_code,
+                'fields' => 'internal_id'


Suggested change

'fields' => 'internal_id'

'fields' => 'internal_id|type'

stefopl · 2026-05-26T17:45:35Z

+            ))
+        );
+        $cache_id = $geocache['internal_id'];
+


Suggested change

self::validate_cache_type($geocache['type']);

stefopl · 2026-05-26T17:46:24Z

+        );
+        return Okapi::formatted_response($request, $result);
+    }
+


Suggested change

private static function validate_cache_type($cache_type)

{

if (Settings::get('OC_BRANCH') != 'oc.pl') {

return;

}

$allowed_types = array(

'Other',

'Quiz',

'Multi',

);

if (!in_array($cache_type, $allowed_types, true)) {

throw new InvalidParam(

'cache_code',

"User coordinates are not supported for cache type '$cache_type'."

);

}

}

OCPL only supports user coordinates for Multi, Quiz, and Other cache types (per ViewCacheController). Fetch the type field alongside internal_id and reject unsupported types with HTTP 400. Also document the OCPL restriction in docs.xml.

hxdimpf · 2026-05-26T18:39:50Z

Thanks @stefopl — all suggestions applied in d27f91d:

Fetching type alongside internal_id so the cache type is available before the DB write.
Added validate_cache_type() which gates on oc.pl only, rejecting Traditional, Virtual, Event, Webcam, Moving, Podcast, and Own with HTTP 400 — matching OCPL's ViewCacheController restriction to Multi, Quiz, and Other.
docs.xml updated to document the OCPL-specific type restriction.

(Personally I think OCPL should support user coordinates for all cache types, but that's a separate discussion — scoping it to the platform constraint for now.)

mlekorlz

Tested end to end on both branches with a real Level 3 OAuth token:

OCPL: local install from the devel dump, PHP 8.1
OCDE: local oc-server3 (development) on ddev, PHP 8.2

Both at 3aab5717 with this branch applied.

The cache_mod_cords fix from the last round is right. The table has a composite primary key and
no id column, so INSERT ... ON DUPLICATE KEY UPDATE is the correct shape:

CREATE TABLE `cache_mod_cords` (
  `cache_id` int(11) NOT NULL,
  `user_id` int(11) NOT NULL,
  `date` timestamp NOT NULL DEFAULT current_timestamp(),
  `longitude` double NOT NULL,
  `latitude` double NOT NULL,
  PRIMARY KEY (`cache_id`,`user_id`),
  KEY `user_id` (`user_id`)
)

what I ran	OCPL	OCDE
first save on an allowed cache type	`{"success":true}`, one row written	`{"success":true}`, one row written
second save, different coordinates	still one row, coords and `date` updated	still one row, updated in place (`id` unchanged, `date_created` kept, `last_modified` bumped)
save on a Traditional cache	HTTP 400, `"User coordinates are not supported for cache type 'Traditional'"`	accepted, as intended since the type gate is `oc.pl` only
read back via `services/caches/geocache` `alt_wpts`	returned as a `user-coords` waypoint with the saved coordinates	same, alongside the cache's existing parking waypoint

Two things I checked specifically because they are branch-dependent:

coordinates on OCDE has date_created and last_modified as NOT NULL with no default, and the
insert here does not set them. That is fine: coordinatesBeforeInsert / coordinatesAfterInsert
fill them, so the insert succeeds even under STRICT_TRANS_TABLES, which is what the ddev install
runs.

The type = 2 constant matches the read side. services/caches/geocaches/WebService.php:1391-1395
already selects from coordinates ... and type = 2 for oc.de, and the round trip above confirms
the reader picks up exactly what this method writes.

No concerns from my side.

hxdimpf force-pushed the save_user-coords branch 3 times, most recently from 88a83ba to 2d3306a Compare November 23, 2023 09:03

hxdimpf mentioned this pull request Nov 23, 2023

No service / method available to upsert a geocache's user-coords #625

Closed

wrygiel requested changes Nov 23, 2023

View reviewed changes

hxdimpf force-pushed the save_user-coords branch 2 times, most recently from 091137a to ad8b421 Compare November 23, 2023 19:16

This comment was marked as resolved.

Sign in to view

hxdimpf force-pushed the save_user-coords branch 2 times, most recently from cccc1cd to 4a5f2f4 Compare November 23, 2023 20:55

issue opencaching#628 save_user_coords

2ce5c31

hxdimpf force-pushed the save_user-coords branch from 4a5f2f4 to b4cb1a9 Compare November 23, 2023 22:31

This comment was marked as resolved.

Sign in to view

hxdimpf force-pushed the save_user-coords branch 4 times, most recently from e8d3b16 to 0462c38 Compare November 24, 2023 09:54

hxdimpf requested a review from wrygiel November 24, 2023 09:57

hxdimpf force-pushed the save_user-coords branch from 0462c38 to e24323f Compare November 25, 2023 20:14

hxdimpf mentioned this pull request Nov 27, 2023

opencaching / okapi, save_user_coordinate cgeo/cgeo#14907

Open

wrygiel reviewed Dec 9, 2023

View reviewed changes

Comment thread okapi/services/caches/save_user_coords/WebService.php Outdated

Comment thread okapi/services/caches/save_user_coords/docs.xml

issue opencaching#628 save_user_coords

5194518

hxdimpf force-pushed the save_user-coords branch from e24323f to 5194518 Compare December 9, 2023 11:02

hxdimpf requested a review from wrygiel December 9, 2023 11:11

Remove unnecessary Db::escape_string on empty string literal

60a163a

Use a simple '' instead of Db::escape_string("") for the empty description value in the INSERT statement.

hxdimpf force-pushed the save_user-coords branch from b8d1c60 to 60a163a Compare March 12, 2026 18:05

stefopl reviewed May 7, 2026

View reviewed changes

fix save_user_coords: use INSERT ON DUPLICATE KEY UPDATE for oc.pl

82d6947

cache_mod_cords has a composite PK (cache_id, user_id) with no id column, so the previous select max(id) would fail at runtime.

stefopl suggested changes May 26, 2026

View reviewed changes

mlekorlz reviewed Aug 7, 2026

View reviewed changes

+    private static function validate_cache_type($cache_type)
+    {
+        if (Settings::get('OC_BRANCH') != 'oc.pl') {
+            return;
+        }
+        $allowed_types = array(
+            'Other',
+            'Quiz',
+            'Multi',
+        );
+        if (!in_array($cache_type, $allowed_types, true)) {
+            throw new InvalidParam(
+                'cache_code',
+                "User coordinates are not supported for cache type '$cache_type'."
+            );
+        }
+    }

Uh oh!

Conversation

hxdimpf commented Nov 23, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

bekuno commented Nov 27, 2023

Uh oh!

Uh oh!

Uh oh!

stefopl May 7, 2026

Choose a reason for hiding this comment

Uh oh!

hxdimpf May 13, 2026

Choose a reason for hiding this comment

Uh oh!

stefopl left a comment

Choose a reason for hiding this comment

Uh oh!

stefopl May 26, 2026

Choose a reason for hiding this comment

Uh oh!

stefopl May 26, 2026

Choose a reason for hiding this comment

Uh oh!

stefopl May 26, 2026

Choose a reason for hiding this comment

Uh oh!

hxdimpf commented May 26, 2026

Uh oh!

mlekorlz left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants